
<!DOCTYPE HTML>
<html lang="" >
    <head>
        <meta charset="UTF-8">
        <meta content="text/html; charset=utf-8" http-equiv="Content-Type">
        <title>Introduction · GitBook</title>
        <meta http-equiv="X-UA-Compatible" content="IE=edge" />
        <meta name="description" content="">
        <meta name="generator" content="GitBook 3.2.3">
        
        
        
    
    <link rel="stylesheet" href="gitbook/style.css">

    
            
                
                <link rel="stylesheet" href="gitbook/gitbook-plugin-highlight/website.css">
                
            
                
                <link rel="stylesheet" href="gitbook/gitbook-plugin-search/search.css">
                
            
                
                <link rel="stylesheet" href="gitbook/gitbook-plugin-fontsettings/website.css">
                
            
        

    

    
        
    
        
    
        
    
        
    
        
    
        
    

        
    
    
    <meta name="HandheldFriendly" content="true"/>
    <meta name="viewport" content="width=device-width, initial-scale=1, user-scalable=no">
    <meta name="apple-mobile-web-app-capable" content="yes">
    <meta name="apple-mobile-web-app-status-bar-style" content="black">
    <link rel="apple-touch-icon-precomposed" sizes="152x152" href="gitbook/images/apple-touch-icon-precomposed-152.png">
    <link rel="shortcut icon" href="gitbook/images/favicon.ico" type="image/x-icon">

    
    

    </head>
    <body>
        
<div class="book">
    <div class="book-summary">
        
            
<div id="book-search-input" role="search">
    <input type="text" placeholder="Type to search" />
</div>

            
                <nav role="navigation">
                


<ul class="summary">
    
    

    

    
        
        
    
        <li class="chapter active" data-level="1.1" data-path="./">
            
                <a href="./">
            
                    
                    Introduction
            
                </a>
            

            
        </li>
    

    

    <li class="divider"></li>

    <li>
        <a href="https://www.gitbook.com" target="blank" class="gitbook-link">
            Published with GitBook
        </a>
    </li>
</ul>


                </nav>
            
        
    </div>

    <div class="book-body">
        
            <div class="body-inner">
                
                    

<div class="book-header" role="navigation">
    

    <!-- Title -->
    <h1>
        <i class="fa fa-circle-o-notch fa-spin"></i>
        <a href="." >Introduction</a>
    </h1>
</div>




                    <div class="page-wrapper" tabindex="-1" role="main">
                        <div class="page-inner">
                            
<div id="book-search-results">
    <div class="search-noresults">
    
                                <section class="normal markdown-section">
                                
                                <h1 id="gitbook-plugin-gitcode-issue-feedback">gitbook-plugin-gitcode-issue-feedback</h1>
<p><a href="https://www.npmjs.com/package/gitbook-plugin-gitcode-issue-feedback" target="_blank"><img src="https://badge.fury.io/js/gitbook-plugin-gitcode-issue-feedback.svg" alt="npm version"></a>
<a href="https://opensource.org/licenses/MIT" target="_blank"><img src="https://img.shields.io/badge/License-MIT-yellow.svg" alt="License: MIT"></a></p>
<p>&#x4E00;&#x4E2A;&#x4E3A; GitBook &#x63D0;&#x4F9B; GitCode &#x95EE;&#x9898;&#x53CD;&#x9988;&#x529F;&#x80FD;&#x7684;&#x63D2;&#x4EF6;&#x3002;&#x8BA9;&#x8BFB;&#x8005;&#x53EF;&#x4EE5;&#x8F7B;&#x677E;&#x5730;&#x4ECE;&#x6587;&#x6863;&#x9875;&#x9762;&#x76F4;&#x63A5;&#x521B;&#x5EFA;&#x95EE;&#x9898;&#x62A5;&#x544A;&#xFF0C;&#x63D0;&#x5347;&#x6587;&#x6863;&#x7EF4;&#x62A4;&#x6548;&#x7387;&#x3002;</p>
<h2 id="&#x2728;-&#x529F;&#x80FD;&#x7279;&#x6027;">&#x2728; &#x529F;&#x80FD;&#x7279;&#x6027;</h2>
<ul>
<li>&#x1F41B; <strong>&#x4E00;&#x952E;&#x95EE;&#x9898;&#x62A5;&#x544A;</strong> - &#x5728;&#x6587;&#x6863;&#x9875;&#x9762;&#x6DFB;&#x52A0;&#x6D6E;&#x52A8;&#x6309;&#x94AE;&#xFF0C;&#x8BFB;&#x8005;&#x53EF;&#x5FEB;&#x901F;&#x521B;&#x5EFA;&#x95EE;&#x9898;&#x62A5;&#x544A;</li>
<li>&#x1F4DD; <strong>&#x667A;&#x80FD;&#x5185;&#x5BB9;&#x63D0;&#x53D6;</strong> - &#x81EA;&#x52A8;&#x63D0;&#x53D6;&#x9009;&#x4E2D;&#x7684;&#x6587;&#x672C;&#x548C;&#x5F53;&#x524D;&#x9875;&#x9762;&#x4FE1;&#x606F;</li>
<li>&#x1F517; <strong>&#x81EA;&#x52A8;&#x751F;&#x6210;&#x94FE;&#x63A5;</strong> - &#x81EA;&#x52A8;&#x751F;&#x6210;&#x6E90;&#x6587;&#x4EF6;&#x94FE;&#x63A5;&#x548C;&#x7F16;&#x8F91;&#x94FE;&#x63A5;</li>
<li>&#x2699;&#xFE0F; <strong>&#x7075;&#x6D3B;&#x914D;&#x7F6E;</strong> - &#x652F;&#x6301;&#x79C1;&#x6709;&#x4ED3;&#x5E93;&#x3001;&#x81EA;&#x5B9A;&#x4E49;&#x6807;&#x7B7E;&#x7B49;&#x591A;&#x79CD;&#x914D;&#x7F6E;&#x9009;&#x9879;</li>
<li>&#x1F3AF; <strong>&#x7CBE;&#x786E;&#x5B9A;&#x4F4D;</strong> - &#x652F;&#x6301;&#x7CBE;&#x786E;&#x5B9A;&#x4F4D;&#x5230;&#x5177;&#x4F53;&#x884C;&#x53F7;&#xFF0C;&#x4FBF;&#x4E8E;&#x95EE;&#x9898;&#x4FEE;&#x590D;</li>
</ul>
<h2 id="&#x1F4E6;-&#x5B89;&#x88C5;">&#x1F4E6; &#x5B89;&#x88C5;</h2>
<p>&#x4F7F;&#x7528; <a href="https://www.npmjs.com/" target="_blank">npm</a> &#x5B89;&#x88C5;&#xFF1A;</p>
<pre><code class="lang-bash">npm install gitbook-plugin-gitcode-issue-feedback
</code></pre>
<h2 id="&#x1F680;-&#x4F7F;&#x7528;&#x65B9;&#x6CD5;">&#x1F680; &#x4F7F;&#x7528;&#x65B9;&#x6CD5;</h2>
<h3 id="&#x57FA;&#x672C;&#x914D;&#x7F6E;">&#x57FA;&#x672C;&#x914D;&#x7F6E;</h3>
<p>&#x5728;&#x60A8;&#x7684; <code>book.json</code> &#x6587;&#x4EF6;&#x4E2D;&#x6DFB;&#x52A0;&#x63D2;&#x4EF6;&#x914D;&#x7F6E;&#xFF1A;</p>
<pre><code class="lang-json">{
    <span class="hljs-string">&quot;gitbook&quot;</span>: <span class="hljs-string">&quot;&gt;=3.0.0&quot;</span>,
    <span class="hljs-string">&quot;title&quot;</span>: <span class="hljs-string">&quot;&#x60A8;&#x7684;&#x6587;&#x6863;&#x6807;&#x9898;&quot;</span>,
    <span class="hljs-string">&quot;plugins&quot;</span>: [
        <span class="hljs-string">&quot;gitcode-issue-feedback&quot;</span>
    ],
    <span class="hljs-string">&quot;pluginsConfig&quot;</span>: {
        <span class="hljs-string">&quot;gitcode-issue-feedback&quot;</span>: {
            <span class="hljs-string">&quot;repo&quot;</span>: <span class="hljs-string">&quot;owner/repository-name&quot;</span>
        }
    }
}
</code></pre>
<h3 id="&#x914D;&#x7F6E;&#x9009;&#x9879;">&#x914D;&#x7F6E;&#x9009;&#x9879;</h3>
<h4 id="&#x5FC5;&#x9700;&#x53C2;&#x6570;">&#x5FC5;&#x9700;&#x53C2;&#x6570;</h4>
<ul>
<li><strong><code>repo</code></strong> (string): GitCode &#x4ED3;&#x5E93;&#x8DEF;&#x5F84;&#xFF0C;&#x683C;&#x5F0F;&#x4E3A; <code>owner/name</code></li>
</ul>
<h4 id="&#x53EF;&#x9009;&#x53C2;&#x6570;">&#x53EF;&#x9009;&#x53C2;&#x6570;</h4>
<ul>
<li><strong><code>label</code></strong> (string): &#x6309;&#x94AE;&#x6807;&#x7B7E;&#x6587;&#x5B57;&#xFF0C;&#x9ED8;&#x8BA4;&#x4E3A; <code>&quot;Bug Report&quot;</code></li>
<li><strong><code>private</code></strong> (boolean): &#x662F;&#x5426;&#x4E3A;&#x79C1;&#x6709;&#x4ED3;&#x5E93;&#xFF0C;&#x9ED8;&#x8BA4;&#x4E3A; <code>false</code></li>
<li><strong><code>newIssueURL</code></strong> (string): &#x81EA;&#x5B9A;&#x4E49;&#x65B0;&#x5EFA;&#x95EE;&#x9898;&#x7684; URL</li>
<li><strong><code>markdownBaseURL</code></strong> (string): &#x8D44;&#x6E90;&#x6587;&#x4EF6;&#x7684;&#x57FA;&#x7840; URL</li>
<li><strong><code>gitcodeAPIBaseURL</code></strong> (string): GitCode API &#x7684;&#x57FA;&#x7840; URL</li>
</ul>
<h3 id="&#x914D;&#x7F6E;&#x793A;&#x4F8B;">&#x914D;&#x7F6E;&#x793A;&#x4F8B;</h3>
<h4 id="&#x79C1;&#x6709;&#x4ED3;&#x5E93;&#x914D;&#x7F6E;">&#x79C1;&#x6709;&#x4ED3;&#x5E93;&#x914D;&#x7F6E;</h4>
<pre><code class="lang-json">{
    <span class="hljs-string">&quot;gitbook&quot;</span>: <span class="hljs-string">&quot;&gt;=3.0.0&quot;</span>,
    <span class="hljs-string">&quot;title&quot;</span>: <span class="hljs-string">&quot;&#x79C1;&#x6709;&#x6587;&#x6863;&quot;</span>,
    <span class="hljs-string">&quot;plugins&quot;</span>: [
        <span class="hljs-string">&quot;gitcode-issue-feedback&quot;</span>
    ],
    <span class="hljs-string">&quot;pluginsConfig&quot;</span>: {
        <span class="hljs-string">&quot;gitcode-issue-feedback&quot;</span>: {
            <span class="hljs-string">&quot;repo&quot;</span>: <span class="hljs-string">&quot;your-org/private-repo&quot;</span>,
            <span class="hljs-string">&quot;private&quot;</span>: <span class="hljs-literal">true</span>,
            <span class="hljs-string">&quot;label&quot;</span>: <span class="hljs-string">&quot;&#x62A5;&#x544A;&#x95EE;&#x9898;&quot;</span>
        }
    }
}
</code></pre>
<h4 id="&#x81EA;&#x5B9A;&#x4E49;-url-&#x914D;&#x7F6E;">&#x81EA;&#x5B9A;&#x4E49; URL &#x914D;&#x7F6E;</h4>
<pre><code class="lang-json">{
    <span class="hljs-string">&quot;gitbook&quot;</span>: <span class="hljs-string">&quot;&gt;=3.0.0&quot;</span>,
    <span class="hljs-string">&quot;title&quot;</span>: <span class="hljs-string">&quot;&#x81EA;&#x5B9A;&#x4E49;&#x914D;&#x7F6E;&#x6587;&#x6863;&quot;</span>,
    <span class="hljs-string">&quot;plugins&quot;</span>: [
        <span class="hljs-string">&quot;gitcode-issue-feedback&quot;</span>
    ],
    <span class="hljs-string">&quot;pluginsConfig&quot;</span>: {
        <span class="hljs-string">&quot;gitcode-issue-feedback&quot;</span>: {
            <span class="hljs-string">&quot;repo&quot;</span>: <span class="hljs-string">&quot;your-org/your-repo&quot;</span>,
            <span class="hljs-string">&quot;label&quot;</span>: <span class="hljs-string">&quot;&#x53CD;&#x9988;&#x95EE;&#x9898;&quot;</span>,
            <span class="hljs-string">&quot;newIssueURL&quot;</span>: <span class="hljs-string">&quot;https://gitcode.com/your-org/your-repo/issues/new&quot;</span>,
            <span class="hljs-string">&quot;markdownBaseURL&quot;</span>: <span class="hljs-string">&quot;https://gitcode.com/your-org/your-repo/blob/master/&quot;</span>,
            <span class="hljs-string">&quot;gitcodeAPIBaseURL&quot;</span>: <span class="hljs-string">&quot;https://api.gitcode.com/repos/your-org/your-repo/contents/&quot;</span>
        }
    }
}
</code></pre>
<h2 id="&#x1F4F8;-&#x6548;&#x679C;&#x5C55;&#x793A;">&#x1F4F8; &#x6548;&#x679C;&#x5C55;&#x793A;</h2>
<p>&#x63D2;&#x4EF6;&#x4F1A;&#x5728;&#x6587;&#x6863;&#x9875;&#x9762;&#x53F3;&#x4E0B;&#x89D2;&#x6DFB;&#x52A0;&#x4E00;&#x4E2A;&#x6D6E;&#x52A8;&#x7684;&#x300C;Bug Report&#x300D;&#x6309;&#x94AE;&#x3002;&#x5F53;&#x7528;&#x6237;&#x70B9;&#x51FB;&#x6309;&#x94AE;&#x65F6;&#xFF0C;&#x4F1A;&#x81EA;&#x52A8;&#xFF1A;</p>
<ol>
<li>&#x63D0;&#x53D6;&#x5F53;&#x524D;&#x9875;&#x9762;&#x6807;&#x9898;</li>
<li>&#x83B7;&#x53D6;&#x9009;&#x4E2D;&#x7684;&#x6587;&#x672C;&#x5185;&#x5BB9;</li>
<li>&#x751F;&#x6210;&#x6E90;&#x6587;&#x4EF6;&#x94FE;&#x63A5;&#x548C;&#x7F16;&#x8F91;&#x94FE;&#x63A5;</li>
<li>&#x8DF3;&#x8F6C;&#x5230; GitCode &#x65B0;&#x5EFA;&#x95EE;&#x9898;&#x9875;&#x9762;</li>
</ol>
<h2 id="&#x1F6E0;&#xFE0F;-&#x5F00;&#x53D1;">&#x1F6E0;&#xFE0F; &#x5F00;&#x53D1;</h2>
<h3 id="&#x672C;&#x5730;&#x5F00;&#x53D1;">&#x672C;&#x5730;&#x5F00;&#x53D1;</h3>
<pre><code class="lang-bash"><span class="hljs-comment"># &#x514B;&#x9686;&#x4ED3;&#x5E93;</span>
git <span class="hljs-built_in">clone</span> https://gitcode.com/nutpi/gitbook-plugin-gitcode-issue-feedback.git
<span class="hljs-built_in">cd</span> gitbook-plugin-gitcode-issue-feedback

<span class="hljs-comment"># &#x5B89;&#x88C5;&#x4F9D;&#x8D56;</span>
npm install

<span class="hljs-comment"># &#x6784;&#x5EFA;&#x9879;&#x76EE;</span>
npm run build

<span class="hljs-comment"># &#x76D1;&#x542C;&#x6587;&#x4EF6;&#x53D8;&#x5316;</span>
npm run watch
</code></pre>
<h3 id="&#x8FD0;&#x884C;&#x6D4B;&#x8BD5;">&#x8FD0;&#x884C;&#x6D4B;&#x8BD5;</h3>
<pre><code class="lang-bash">npm <span class="hljs-built_in">test</span>
</code></pre>
<h2 id="&#x1F4DD;-&#x66F4;&#x65B0;&#x65E5;&#x5FD7;">&#x1F4DD; &#x66F4;&#x65B0;&#x65E5;&#x5FD7;</h2>
<p>&#x67E5;&#x770B; <a href="https://gitcode.com/nutpi/gitbook-plugin-gitcode-issue-feedback/releases" target="_blank">Releases &#x9875;&#x9762;</a> &#x4E86;&#x89E3;&#x7248;&#x672C;&#x66F4;&#x65B0;&#x8BE6;&#x60C5;&#x3002;</p>
<h2 id="&#x1F91D;-&#x8D21;&#x732E;">&#x1F91D; &#x8D21;&#x732E;</h2>
<p>&#x6211;&#x4EEC;&#x6B22;&#x8FCE;&#x5404;&#x79CD;&#x5F62;&#x5F0F;&#x7684;&#x8D21;&#x732E;&#xFF01;</p>
<h3 id="&#x62A5;&#x544A;&#x95EE;&#x9898;">&#x62A5;&#x544A;&#x95EE;&#x9898;</h3>
<p>&#x5982;&#x679C;&#x60A8;&#x53D1;&#x73B0;&#x4E86; bug &#x6216;&#x6709;&#x529F;&#x80FD;&#x5EFA;&#x8BAE;&#xFF0C;&#x8BF7; <a href="https://gitcode.com/nutpi/gitbook-plugin-gitcode-issue-feedback/issues" target="_blank">&#x521B;&#x5EFA;&#x4E00;&#x4E2A; issue</a>&#x3002;</p>
<h3 id="&#x63D0;&#x4EA4;&#x4EE3;&#x7801;">&#x63D0;&#x4EA4;&#x4EE3;&#x7801;</h3>
<ol>
<li>Fork &#x672C;&#x4ED3;&#x5E93;</li>
<li>&#x521B;&#x5EFA;&#x60A8;&#x7684;&#x529F;&#x80FD;&#x5206;&#x652F;&#xFF1A;<code>git checkout -b feature/amazing-feature</code></li>
<li>&#x63D0;&#x4EA4;&#x60A8;&#x7684;&#x66F4;&#x6539;&#xFF1A;<code>git commit -m &apos;Add some amazing feature&apos;</code></li>
<li>&#x63A8;&#x9001;&#x5230;&#x5206;&#x652F;&#xFF1A;<code>git push origin feature/amazing-feature</code></li>
<li>&#x63D0;&#x4EA4; Pull Request</li>
</ol>
<h2 id="&#x1F468;&#x200D;&#x1F4BB;-&#x4F5C;&#x8005;">&#x1F468;&#x200D;&#x1F4BB; &#x4F5C;&#x8005;</h2>
<ul>
<li><a href="https://gitcode.com/nutpi" target="_blank">GitCode/nutpi</a></li>
</ul>
<h2 id="&#x1F4C4;-&#x8BB8;&#x53EF;&#x8BC1;">&#x1F4C4; &#x8BB8;&#x53EF;&#x8BC1;</h2>
<p>&#x672C;&#x9879;&#x76EE;&#x57FA;&#x4E8E; <a href="LICENSE">MIT &#x8BB8;&#x53EF;&#x8BC1;</a> &#x5F00;&#x6E90;&#x3002;</p>
<hr>
<p>&#x2B50; &#x5982;&#x679C;&#x8FD9;&#x4E2A;&#x9879;&#x76EE;&#x5BF9;&#x60A8;&#x6709;&#x5E2E;&#x52A9;&#xFF0C;&#x8BF7;&#x7ED9;&#x6211;&#x4EEC;&#x4E00;&#x4E2A; Star&#xFF01;</p>

                                
                                </section>
                            
    </div>
    <div class="search-results">
        <div class="has-results">
            
            <h1 class="search-results-title"><span class='search-results-count'></span> results matching "<span class='search-query'></span>"</h1>
            <ul class="search-results-list"></ul>
            
        </div>
        <div class="no-results">
            
            <h1 class="search-results-title">No results matching "<span class='search-query'></span>"</h1>
            
        </div>
    </div>
</div>

                        </div>
                    </div>
                
            </div>

            
                
                
            
        
    </div>

    <script>
        var gitbook = gitbook || [];
        gitbook.push(function() {
            gitbook.page.hasChanged({"page":{"title":"Introduction","level":"1.1","depth":1,"dir":"ltr"},"config":{"gitbook":"*","theme":"default","variables":{},"plugins":["livereload"],"pluginsConfig":{"livereload":{},"highlight":{},"search":{},"lunr":{"maxIndexSize":1000000,"ignoreSpecialCharacters":false},"sharing":{"facebook":true,"twitter":true,"google":false,"weibo":false,"instapaper":false,"vk":false,"all":["facebook","google","twitter","weibo","instapaper"]},"fontsettings":{"theme":"white","family":"sans","size":2},"theme-default":{"styles":{"pdf":"styles/pdf.css","epub":"styles/epub.css","mobi":"styles/mobi.css","ebook":"styles/ebook.css","print":"styles/print.css","website":"styles/website.css"},"showLevel":false}},"structure":{"langs":"LANGS.md","readme":"README.md","glossary":"GLOSSARY.md","summary":"SUMMARY.md"},"pdf":{"pageNumbers":true,"fontSize":12,"fontFamily":"Arial","paperSize":"a4","chapterMark":"pagebreak","pageBreaksBefore":"/","margin":{"right":62,"left":62,"top":56,"bottom":56}},"styles":{"pdf":"styles/pdf.css","epub":"styles/epub.css","mobi":"styles/mobi.css","ebook":"styles/ebook.css","print":"styles/print.css","website":"styles/website.css"}},"file":{"path":"README.md","mtime":"2025-09-12T00:08:09.366Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2025-09-12T06:52:23.675Z"},"basePath":".","book":{"language":""}});
        });
    </script>
</div>

        
    <script src="gitbook/gitbook.js"></script>
    <script src="gitbook/theme.js"></script>
    
        
        <script src="gitbook/gitbook-plugin-livereload/plugin.js"></script>
        
    
        
        <script src="gitbook/gitbook-plugin-search/search-engine.js"></script>
        
    
        
        <script src="gitbook/gitbook-plugin-search/search.js"></script>
        
    
        
        <script src="gitbook/gitbook-plugin-lunr/lunr.min.js"></script>
        
    
        
        <script src="gitbook/gitbook-plugin-lunr/search-lunr.js"></script>
        
    
        
        <script src="gitbook/gitbook-plugin-sharing/buttons.js"></script>
        
    
        
        <script src="gitbook/gitbook-plugin-fontsettings/fontsettings.js"></script>
        
    

    </body>
</html>

